Authenticate Keys

📝 Overview

The AuthenticateKeys API validates SynapseWave Innovations Private Limited–issued application API keys and returns a session token, which must be included in the authorization header for all subsequent API calls.

🔗 Endpoint

Method	URL
POST	<protocol>://<host name>:<service port>/<service name>/<tenantid>/v1/authenticateKeys

Request

📥 Parameters

Parameter	Data Type	Mandatory / Optional	Description
apiKey	String	Mandatory	API key provided by SynapseWave Innovations Private Limited
secretKey	String	Mandatory	Secret key provided by SynapseWave Innovations Private Limited

Example Request Body

{
  "apiKey": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJDdXN0b21lcklkIjoiMTUyMyIsIm5Ob2RlTGljZW5zZUV4cGlyeSI6IjE4OTM2MDkwMDAiLCJpYXQiOjE1NjM2MDI2Nzd9.oRVgIlN3K_m5AXh_K1M88exzBg96CYJEVo_LQ-SY5Kd",
  "secretKey": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJDdXN0b21lcklkIjoiMTUyMyIsIm5Ob2RlTGljZW5zZUV4cGlyeSI6IjE4OTM2MDkwMDAiLCJpYXQiOjE1NjM2MDI2Nzd9.oRVgIlN3K_m5AXh_K1M88exzBg96CYJEVo_LQ-SY5Kd"
}

---

Response

The ResponseObject contains the following parameters in a JSON object:

📦 Response Parameters

Parameter (Key)	Data Type	Description
status	boolean	Status of the request. true if a session key is generated, false if an error occurred.
errorCode	string	Error code, if any error occurred.
errorString	string	Error description.
sessionKey	string	Generated session key. This must be passed in the Authorization header for all subsequent API requests.

Example Responses

🟢 Success Response

{
  "status": true,
  "errorCode": "",
  "errorString": "",
  "sessionKey": "eyBDyGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJDdXN0b21lcklkIjoiMTUyMyIsIm5Ob2RlTGljZW5zZUV4cGlyeSI6IjE4OTM2MDkwMDAiLCJpYXQiOjE1NjM2MDI2Nzd9.oRVgIlN3K_m5AXh_K1M88exzBg96CYJEVo_LQ-YZ6Yd"
}

🔴 Error Response

{
  "status": false,
  "errorCode": "500",
  "errorString": "Invalid API key / Secret key",
  "sessionKey": ""
}